PR Summary

Sci/Tech Reviewer: @thomasmelvin
Code Reviewer: @EdHone

This PR picks up on the new coordinate field namelist options from MetOffice/lfric_core#238, and sets some key apps to use the new Wtheta coordinate space.

A handful of science changes were necessary to get this to work -- these are detailed below. Otherwise, the vast majority of changes involve the addition of the new namelist options into all of the required files.

Please See

This branch is built on the changes in #277, and until that is merged the diff on this PR will also include the changes from that branch. I have created PRs in my own fork to show useful diffs for reviewing:

• Diff for code changes in this PR
• Diff for test branch to show action of upgrade macro, and KGO changes

Linked-To

• LFRic Core#238, which contains the main science changes
• LFRic-JEDI#1238
• JJTests#159

Blocked-By

This branch includes the changes from #277, which are necessary to be able to safely use a Wtheta space for the coordinate fields.

• LFRic Core #284 and its linked ticket, LFRic Apps #277

Blocks

The ultimate aim of this work is to facilitate moving to coord_order=2 to give a better representation of the orography.

• LFRic Apps #180

Details

Some science changes were necessary to allow the use of a Wtheta-like coordinate space:

1. science/gungho/source/orography/assign_orography_field_mod.F90:

• the routines in this file assume that chi is discontinuous, and modify the DoFs in place. I have rewritten this file to make a copy of chi before the coordinates are adjusted to account for orography, which allows them to work in the case of (partial) continuity

2. science/gungho/source/algorithm/limited_area/limited_area_masks_alg_mod.x90:

• the coordinate_based option for specifying LBCs assumes the coordinate values are in the corner of DoFs. To ensure this still works, I copy the coordinate fields into Wchi

3. science/gungho/source/kernel/initialisation/sample_initial_u_kernel_mod.F90 was hard-coded to use details around the lowest-order Wchi space. To avoid issues, the kernel has been changed to avoid using the chi field, and instead uses the dA_at_w2 field (which will be valid for any coordinate options)

Otherwise the changes involve picking up the Core branch:

1. Kernels specifying the Wchi space have been changed to ANY_SPACE_9 (this is not necessary but feels safe)
2. The new namelist options have been added to configuration.nml files
3. New namelist options are added to any feign_configs in unit-tests
4. The gungho_model, lfric_atm, linear_model and jedi_lfric apps use the Wtheta coordinate space

Results

The attached PDFs show plots from the gungho_model and lfric_atm test suites, indicating that the change to use a Wtheta-like coordinate space is science-neutral:

• gungho model plots
• lfric_atm plots

Some timing results are shown in the following table, showing changes to timing are within normal variability for this change (note that bigger savings are expected when comparing between 'Wchi' and 'Wtheta' coordinate spaces for coord_order=2)

Code Quality Checklist

• I have performed a self-review of my own code
• My code follows the project's style guidelines
• Comments have been included that aid understanding and enhance the readability of the code
• My changes generate no new warnings
• All automated checks in the CI pipeline have completed successfully

Testing

• I have tested this change locally, using the LFRic Core rose-stem suite
• If required (e.g. API changes) I have also run the LFRic Apps test suite using this branch
• If any tests fail (rose-stem or CI) the reason is understood and acceptable (e.g. kgo changes)
• I have added tests to cover new functionality as appropriate (e.g. system tests, unit tests, etc.)
• Any new tests have been assigned an appropriate amount of compute resource and have been allocated to an appropriate testing group (i.e. the developer tests are for jobs which use a small amount of compute resource and complete in a matter of minutes)

trac.log

Test Suite Results - lfric_apps - test_coord_space_apps/run27

Suite Information

Task Information

✅ succeeded tasks - 1511

Security Considerations

• I have reviewed my changes for potential security issues
• Sensitive data is properly handled (if applicable)
• Authentication and authorisation are properly implemented (if applicable)

Performance Impact

• Performance of the code has been considered and, if applicable, suitable performance measurements have been conducted

AI Assistance and Attribution

• Some of the content of this change has been produced with the assistance of Generative AI tool name (e.g., Met Office Github Copilot Enterprise, Github Copilot Personal, ChatGPT GPT-4, etc) and I have followed the Simulation Systems AI policy (including attribution labels)

Documentation

• Where appropriate I have updated documentation related to this change and confirmed that it builds correctly

PSyclone Approval

• If you have edited any PSyclone-related code (e.g. PSyKAl-lite, Kernel interface, optimisation scripts, LFRic data structure code) then please contact the TCD Team

Sci/Tech Review

• I understand this area of code and the changes being added
• The proposed changes correspond to the pull request description
• Documentation is sufficient (do documentation papers need updating)
• Sufficient testing has been completed

(Please alert the code reviewer via a tag when you have approved the SR)

Code Review

• All dependencies have been resolved
• Related Issues have been properly linked and addressed
• CLA compliance has been confirmed
• Code quality standards have been met
• Tests are adequate and have passed
• Documentation is complete and accurate
• Security considerations have been addressed
• Performance impact is acceptable